GetFullRequestSampleByInstanceId - 按照SQL ID查询SQL样本数据

调用GetFullRequestSampleByInstanceId接口,按照SQL ID查询数据库实例SQL洞察结果中的SQL样本数据,最大返回20条样本数据。

接口说明

SQL 洞察功能可对 SQL 进行健康情况诊断、性能问题排查,详情请参见 SQL 洞察

  • 支持的数据库引擎请参见 SQL 洞察
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
UserIdstring

用户 ID,即创建数据库实例的阿里云主账号 ID。

说明 非必填,输入目标数据库实例 ID 后,在调用 API 接口时,系统会自动获取用户 ID。
196278346919****
InstanceIdstring

实例 ID。

rm-2ze8g2am97624****
SqlIdstring

SQL ID。

651b56fe9418d48edb8fdf0980ec****
Startlong

查询开始时间,格式为 Unix 时间戳,单位为毫秒。

说明 查询开始时间需要在数据库实例 SQL 洞察存储时长范围内,最大不能早于当前时间 90 天。
1660097421000
Endlong

查询结束时间,格式为 Unix 时间戳,单位为毫秒。

说明 查询结束时间需晚于查询开始时间,且查询开始时间和查询结束时间的间隔不能小于 1 小时。
1660104621000
Rolestring

PolarDB-X 2.0 数据库实例节点信息。

  • polarx_cn:计算节点。
  • polarx_en:数据节点。
polarx_cn

返回参数

名称类型描述示例值
object
Codelong

返回的状态码。

200
Dataarray<object>

返回数据

Itemobject
Databasestring

数据库名。

dbtest
Frowslong

PolarDB-X 2.0 计算节点(CN)的拉取行数。

0
LockWaitTimedouble

锁等待时长,单位为秒。

0.0137
LogicalReaddouble

逻辑读。

165848
OriginHoststring

访问来源。

172.17.XX.XX
PhysicalAsyncReaddouble

物理异步读取。

0
PhysicalSyncReaddouble

物理同步读取。

0
Rowslong

PolarDB-X 2.0 计算节点(CN)的更新/返回行数。

0
RowsExaminedlong

总扫描行数。

说明 目前支持该字段的数据库:RDS MySQL、RDS PostgreSQL、PolarDB MySQL 版。
2048576
RowsReturnedlong

返回行数。

14
Rtdouble

执行耗时,单位为秒。

0.409789
ScanRowslong

扫描行数。

0
Scntlong

PolarDB-X 2.0 计算节点(CN)的 DN 请求数。

0
Sqlstring

SQL 样本。

select * from testdb01 where ****
SqlIdstring

SQL ID。

651b56fe9418d48edb8fdf0980ec****
SqlTypestring

SQL 语句的类型,取值包括:SELECTINSERTUPDATEDELETELOGINLOGOUTMERGEALTERCREATEINDEXDROPINDEXCREATEDROPSETDESCREPLACECALLBEGINDESCRIBEROLLBACKFLUSHUSESHOWSTARTCOMMITRENAME

SELECT
Timestamplong

执行 SQL 的时间,格式为 Unix 时间戳,单位为毫秒。

1660100753556
UpdateRowslong

更新行数。

0
Userstring

执行 SQL 的用户名称。

testuser
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

请求 ID。

0A74B755-98B7-59DB-8724-1321B394****
Successboolean

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Data": [
    {
      "Database": "dbtest",
      "Frows": 0,
      "LockWaitTime": 0.0137,
      "LogicalRead": 165848,
      "OriginHost": "172.17.XX.XX",
      "PhysicalAsyncRead": 0,
      "PhysicalSyncRead": 0,
      "Rows": 0,
      "RowsExamined": 2048576,
      "RowsReturned": 14,
      "Rt": 0.409789,
      "ScanRows": 0,
      "Scnt": 0,
      "Sql": "select * from testdb01 where ****",
      "SqlId": "651b56fe9418d48edb8fdf0980ec****",
      "SqlType": "SELECT",
      "Timestamp": 1660100753556,
      "UpdateRows": 0,
      "User": "testuser"
    }
  ],
  "Message": "Successful",
  "RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-08-15新增 OpenAPI查看变更详情